docs: Move documentation to inline comments: GtkPageSetup

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=634340

Signed-off-by: Javier Jardón <jjardon@gnome.org>

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 5fa9fd446386fa89c838a8b08dd2db5fce8faaa8..5ac6dc17a58e82aacbbe8ef188d6a97ea8f91cb0 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -30,6 +30,7 @@ gtkmessagedialog.sgml
 gtknotebook.sgml
 gtkobject.sgml
 gtkorientable.sgml
+gtkpagesetup.sgml
 gtkpagesetupunixdialog.sgml
 gtkpapersize.sgml
 gtkprinter.sgml

diff --git a/docs/reference/gtk/tmpl/gtkpagesetup.sgml b/docs/reference/gtk/tmpl/gtkpagesetup.sgml
deleted file mode 100644 (file)
index cac99e1..0000000
--- a/docs/reference/gtk/tmpl/gtkpagesetup.sgml
+++ /dev/null
@@ -1,320 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkPageSetup
-
-<!-- ##### SECTION Short_Description ##### -->
-Stores page setup information
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A GtkPageSetup object stores the page size, orientation and margins. 
-The idea is that you can get one of these from the page setup dialog 
-and then pass it to the #GtkPrintOperation when printing. 
-The benefit of splitting this out of the #GtkPrintSettings is that 
-these affect the actual layout of the page, and thus need to be set 
-long before user prints. 
-</para>
-<para id="print-margins">
-The margins specified in this object are the "print margins", i.e. the 
-parts of the page that the printer cannot print on. These are different
-from the layout margins that a word processor uses; they are typically
-used to determine the <emphasis>minimal</emphasis> size for the layout 
-margins.
-</para>
-<para>
-To obtain a #GtkPageSetup use gtk_page_setup_new()
-to get the defaults, or use gtk_print_run_page_setup_dialog() to show 
-the page setup dialog and receive the resulting page setup.
-</para>
-<example>
-<title>A page setup dialog</title>
-<programlisting>
-static GtkPrintSettings *settings = NULL;
-static GtkPageSetup *page_setup = NULL;
-
-static void
-do_page_setup (void)
-{
-  GtkPageSetup *new_page_setup;
-
-  if (settings == NULL)
-    settings = gtk_print_settings_new (<!-- -->);
-
-  new_page_setup = gtk_print_run_page_setup_dialog (GTK_WINDOW (main_window),
-                                                    page_setup, settings);
-
-  if (page_setup)
-    g_object_unref (page_setup);
-
-  page_setup = new_page_setup;
-}
-</programlisting>
-</example>
-<para>
-Printing support was added in GTK+ 2.10.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkPageSetup ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gtk_page_setup_new ##### -->
-<para>
-
-</para>
-
-@void: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_copy ##### -->
-<para>
-
-</para>
-
-@other: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_orientation ##### -->
-<para>
-
-</para>
-
-@setup: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_set_orientation ##### -->
-<para>
-
-</para>
-
-@setup: 
-@orientation: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_paper_size ##### -->
-<para>
-
-</para>
-
-@setup: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_set_paper_size ##### -->
-<para>
-
-</para>
-
-@setup: 
-@size: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_top_margin ##### -->
-<para>
-
-</para>
-
-@setup: 
-@unit: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_set_top_margin ##### -->
-<para>
-
-</para>
-
-@setup: 
-@margin: 
-@unit: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_bottom_margin ##### -->
-<para>
-
-</para>
-
-@setup: 
-@unit: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_set_bottom_margin ##### -->
-<para>
-
-</para>
-
-@setup: 
-@margin: 
-@unit: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_left_margin ##### -->
-<para>
-
-</para>
-
-@setup: 
-@unit: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_set_left_margin ##### -->
-<para>
-
-</para>
-
-@setup: 
-@margin: 
-@unit: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_right_margin ##### -->
-<para>
-
-</para>
-
-@setup: 
-@unit: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_set_right_margin ##### -->
-<para>
-
-</para>
-
-@setup: 
-@margin: 
-@unit: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_set_paper_size_and_default_margins ##### -->
-<para>
-
-</para>
-
-@setup: 
-@size: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_paper_width ##### -->
-<para>
-
-</para>
-
-@setup: 
-@unit: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_paper_height ##### -->
-<para>
-
-</para>
-
-@setup: 
-@unit: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_page_width ##### -->
-<para>
-
-</para>
-
-@setup: 
-@unit: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_get_page_height ##### -->
-<para>
-
-</para>
-
-@setup: 
-@unit: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_new_from_file ##### -->
-<para>
-
-</para>
-
-@file_name: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_new_from_key_file ##### -->
-<para>
-
-</para>
-
-@key_file: 
-@group_name: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_load_file ##### -->
-<para>
-
-</para>
-
-@setup: 
-@file_name: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_load_key_file ##### -->
-<para>
-
-</para>
-
-@setup: 
-@key_file: 
-@group_name: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_to_file ##### -->
-<para>
-
-</para>
-
-@setup: 
-@file_name: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_page_setup_to_key_file ##### -->
-<para>
-
-</para>
-
-@setup: 
-@key_file: 
-@group_name: 
-
-

diff --git a/gtk/gtkpagesetup.c b/gtk/gtkpagesetup.c
index 8c56a69d25f2545311e15b2b42678e02b93ac209..a00177efd6a30034ac22806abf133d2fd0cedd08 100644 (file)
--- a/gtk/gtkpagesetup.c
+++ b/gtk/gtkpagesetup.c
@@ -26,6 +26,58 @@
 #include "gtkintl.h"
 #include "gtktypebuiltins.h"
 
+/**
+ * SECTION:gtkpagesetup
+ * @Short_description: Stores page setup information
+ * @Title: GtkPageSetup
+ *
+ * A GtkPageSetup object stores the page size, orientation and margins.
+ * The idea is that you can get one of these from the page setup dialog
+ * and then pass it to the #GtkPrintOperation when printing.
+ * The benefit of splitting this out of the #GtkPrintSettings is that
+ * these affect the actual layout of the page, and thus need to be set
+ * long before user prints.
+ *
+ * <para id="print-margins">
+ * The margins specified in this object are the "print margins", i.e. the
+ * parts of the page that the printer cannot print on. These are different
+ * from the layout margins that a word processor uses; they are typically
+ * used to determine the <emphasis>minimal</emphasis> size for the layout
+ * margins.
+ * </para>
+ *
+ * To obtain a #GtkPageSetup use gtk_page_setup_new() to get the defaults,
+ * or use gtk_print_run_page_setup_dialog() to show the page setup dialog
+ * and receive the resulting page setup.
+ *
+ * <example>
+ * <title>A page setup dialog</title>
+ * <programlisting>
+ * static GtkPrintSettings *settings = NULL;
+ * static GtkPageSetup *page_setup = NULL;
+ *
+ * static void
+ * do_page_setup (void)
+ * {
+ *   GtkPageSetup *new_page_setup;
+ *
+ *   if (settings == NULL)
+ *     settings = gtk_print_settings_new (<!-- -->);
+ *
+ *   new_page_setup = gtk_print_run_page_setup_dialog (GTK_WINDOW (main_window),
+ *                                                     page_setup, settings);
+ *
+ *   if (page_setup)
+ *     g_object_unref (page_setup);
+ *
+ *   page_setup = new_page_setup;
+ * }
+ * </programlisting>
+ * </example>
+ *
+ * Printing support was added in GTK+ 2.10.
+ */
+
 #define KEYFILE_GROUP_NAME "Page Setup"
 
 typedef struct _GtkPageSetupClass GtkPageSetupClass;